RAIS::Common::UserManagement::FunctionRole Class Reference

This class encapsulates all functional role properties. More...

Inheritance diagram for RAIS::Common::UserManagement::FunctionRole:

List of all members.

Classes
class	Category
	This class encapsulates all functional role category properties. More...
class	FunctionRoleTypeData
	This class encapsulates all functional role validation type properties. More...
class	Subcategory
	This class encapsulates all functional role subcategory properties. More...
class	ValidationTypeData
	This class encapsulates all functional role validation type properties. More...
Public Types
enum	ValidationType { NeedsValidation = 0, Validates, DoesNotNeedValidation }
enum	FunctionRoleType {   Administrator, Regulator, Licensee, PublicBody,   Guest, Other }
Public Member Functions
	FunctionRole ()
	FunctionRole (IDataRecord record)
bool	ContainsCategoryRestriction (string catregoryName)
bool	ContainsSubcategoryRestriction (FunctionRole.Category category, string subcatregoryName)
bool	ContainsMaskRestriction (FunctionRole.Category category, FunctionRole.Subcategory subcategory, string maskName)
bool	ValidateNewAttribute (FunctionRoleAttribute newAttribute, ref string returnMessage)
bool	AddAttribute (FunctionRoleAttribute newAttribute, ref string returnMessage)
bool	RemoveAttribute (FunctionRoleAttribute removedAttribute, ref string returnMessage)
bool	AddUserType (UserTypeData newUserType, ref string returnMessage)
bool	RemoveUserType (UserTypeData removedUserType, ref string returnMessage)
FunctionRoleAttribute	GetAttributeByIndex (int index)
Properties
static ValidationType	DefaltValidation [get]
	Gets the role's default validaiton type value.
static FunctionRoleType	DefaltType [get]
	Gets the role's default validaiton type value.
static Dictionary < ValidationType, ValidationTypeData >	ValidationTypesDictionary [get, set]
	This method Gets or Sets a list of all available functional role validation types.
static FunctionRoleValidationTypesByName	ValidationTypeNamesDictionary [get, set]
	This method Gets or Sets a list of all available functional role validation types by name.
static Dictionary < FunctionRoleType, FunctionRoleTypeData >	FunctionRoleTypesDictionary [get, set]
	This method Gets or Sets a list of all available functional role types.
ValidationType	Validation [get, set]
	Gets and sets the role's validaiton type value.
ValidationTypeData	ValidationData [get]
	Gets and sets the role's validaiton type value.
FunctionRoleAttributes	Attributes [get, set]
	Gets and sets the role's attributes colleciton.
FunctionRoleAttributes	AddedAttributes [get, set]
	Gets the collection of added role's attributes.
FunctionRoleAttributes	RemovedAttributes [get]
	Gets the collection of removed role's attributes.
UserTypes	AddedUserTypes [get]
	Gets the collection of added role's user types.
UserTypes	RemovedUserTypes [get]
	Gets the collection of removed role's user types.
bool	Modified [get, set]
	Gets and sets "modified" flag.
UserTypes	UserTypes [get, set]
	Gets and sets userTypes flag.
FunctionRoleType	Type [get]
	Gets FunctionRoleType.
FunctionRoleTypeData	TypeData [get]
	Gets and sets the role's validaiton type value.

---

Detailed Description

This class encapsulates all functional role properties.

---

Member Enumeration Documentation

enum RAIS::Common::UserManagement::FunctionRole::FunctionRoleType

Enumerator:

Administrator
Regulator
Licensee
PublicBody
Guest
Other

Definition at line 52 of file FunctionRole.cs.

enum RAIS::Common::UserManagement::FunctionRole::ValidationType

Enumerator:

NeedsValidation
Validates
DoesNotNeedValidation

Definition at line 46 of file FunctionRole.cs.

---

Constructor & Destructor Documentation

RAIS::Common::UserManagement::FunctionRole::FunctionRole

(

)

Definition at line 235 of file FunctionRole.cs.

RAIS::Common::UserManagement::FunctionRole::FunctionRole

(

IDataRecord

record

)

Definition at line 239 of file FunctionRole.cs.

---

Member Function Documentation

bool RAIS::Common::UserManagement::FunctionRole::AddAttribute	(	FunctionRoleAttribute	newAttribute,
		ref string	returnMessage
	)

Definition at line 300 of file FunctionRole.cs.

bool RAIS::Common::UserManagement::FunctionRole::AddUserType	(	UserTypeData	newUserType,
		ref string	returnMessage
	)

Definition at line 328 of file FunctionRole.cs.

bool RAIS::Common::UserManagement::FunctionRole::ContainsCategoryRestriction

(

string

catregoryName

)

Definition at line 250 of file FunctionRole.cs.

bool RAIS::Common::UserManagement::FunctionRole::ContainsMaskRestriction	(	FunctionRole.Category	category,
		FunctionRole.Subcategory	subcategory,
		string	maskName
	)

Definition at line 269 of file FunctionRole.cs.

bool RAIS::Common::UserManagement::FunctionRole::ContainsSubcategoryRestriction	(	FunctionRole.Category	category,
		string	subcatregoryName
	)

Definition at line 259 of file FunctionRole.cs.

FunctionRoleAttribute RAIS::Common::UserManagement::FunctionRole::GetAttributeByIndex

(

int

index

)

Definition at line 356 of file FunctionRole.cs.

bool RAIS::Common::UserManagement::FunctionRole::RemoveAttribute	(	FunctionRoleAttribute	removedAttribute,
		ref string	returnMessage
	)

Definition at line 316 of file FunctionRole.cs.

bool RAIS::Common::UserManagement::FunctionRole::RemoveUserType	(	UserTypeData	removedUserType,
		ref string	returnMessage
	)

Definition at line 340 of file FunctionRole.cs.

bool RAIS::Common::UserManagement::FunctionRole::ValidateNewAttribute	(	FunctionRoleAttribute	newAttribute,
		ref string	returnMessage
	)

Definition at line 282 of file FunctionRole.cs.

---

Property Documentation

FunctionRoleAttributes RAIS::Common::UserManagement::FunctionRole::AddedAttributes [get, set]

Gets the collection of added role's attributes.

Definition at line 156 of file FunctionRole.cs.

UserTypes RAIS::Common::UserManagement::FunctionRole::AddedUserTypes [get]

Gets the collection of added role's user types.

Definition at line 171 of file FunctionRole.cs.

FunctionRoleAttributes RAIS::Common::UserManagement::FunctionRole::Attributes [get, set]

Gets and sets the role's attributes colleciton.

Definition at line 148 of file FunctionRole.cs.

FunctionRoleType RAIS::Common::UserManagement::FunctionRole::DefaltType [static, get]

Gets the role's default validaiton type value.

Definition at line 91 of file FunctionRole.cs.

ValidationType RAIS::Common::UserManagement::FunctionRole::DefaltValidation [static, get]

Gets the role's default validaiton type value.

Definition at line 84 of file FunctionRole.cs.

Dictionary<FunctionRoleType, FunctionRoleTypeData> RAIS::Common::UserManagement::FunctionRole::FunctionRoleTypesDictionary [static, get, set]

This method Gets or Sets a list of all available functional role types.

Returns:

Dictionary of functional role type vs FunctionalRoleTypeData objects

Definition at line 120 of file FunctionRole.cs.

bool RAIS::Common::UserManagement::FunctionRole::Modified [get, set]

Gets and sets "modified" flag.

Definition at line 185 of file FunctionRole.cs.

FunctionRoleAttributes RAIS::Common::UserManagement::FunctionRole::RemovedAttributes [get]

Gets the collection of removed role's attributes.

Definition at line 164 of file FunctionRole.cs.

UserTypes RAIS::Common::UserManagement::FunctionRole::RemovedUserTypes [get]

Gets the collection of removed role's user types.

Definition at line 178 of file FunctionRole.cs.

FunctionRoleType RAIS::Common::UserManagement::FunctionRole::Type [get]

Gets FunctionRoleType.

Definition at line 211 of file FunctionRole.cs.

FunctionRoleTypeData RAIS::Common::UserManagement::FunctionRole::TypeData [get]

Gets and sets the role's validaiton type value.

Definition at line 229 of file FunctionRole.cs.

UserTypes RAIS::Common::UserManagement::FunctionRole::UserTypes [get, set]

Gets and sets userTypes flag.

Definition at line 203 of file FunctionRole.cs.

ValidationType RAIS::Common::UserManagement::FunctionRole::Validation [get, set]

Gets and sets the role's validaiton type value.

Definition at line 129 of file FunctionRole.cs.

ValidationTypeData RAIS::Common::UserManagement::FunctionRole::ValidationData [get]

Gets and sets the role's validaiton type value.

Definition at line 141 of file FunctionRole.cs.

FunctionRoleValidationTypesByName RAIS::Common::UserManagement::FunctionRole::ValidationTypeNamesDictionary [static, get, set]

This method Gets or Sets a list of all available functional role validation types by name.

Returns:

Dictionary of functional role validation type names vs ValidationTypeData objects

Definition at line 110 of file FunctionRole.cs.

Dictionary<ValidationType, ValidationTypeData> RAIS::Common::UserManagement::FunctionRole::ValidationTypesDictionary [static, get, set]

This method Gets or Sets a list of all available functional role validation types.

Returns:

Dictionary of functional role validation type vs ValidationTypeData objects

Definition at line 100 of file FunctionRole.cs.

---

The documentation for this class was generated from the following file:

• C:/Projekte/RAIS/common/FunctionRole.cs